Repository navigation
Fix the runtime guide link in the published TurnEnvelope docs - #9186
Conversation
Signed-off-by: LoopX Agent <[email protected]>
loopx-agent
left a comment
There was a problem hiding this comment.
Reviewer: model_agent · gpt-6.2-sol · OpenAI (runtime_reported, xhigh)
动机 / Motivation
发布站点的维护者和需要查阅 Benchmark 运行配置的协议读者。 严格模式生成站点时,旧的相对链接找不到文档树之外的运行指南,整个文档构建中止。 用同一条命令运行候选后,严格构建成功,生成页面的运行指南链接指向仓库主干中现存的原文件。 本次在本地验证构建与生成页面,公开站点的部署结果留待发布读回。
改动思路 / Approach
保留现有文档结构,只替换原有锚点的目标 URL。 MkDocs 会检查文档树内的相对路径。原指南由 benchmark runtime 目录维护,生成页面可以直接链接到仓库中的原指南。
具体改动 / Changes
关键内容讲解
在精确提交 d761eb95568007101554f7ab65cc67b669fd1b58,strict-documentation-link 已实现。Pages 工作流要求严格构建,协议页保留原链接文字。生成 HTML 中恰好有一个指向原指南的锚点,主干中可读回该文件。 Pages 工作流 当前协议页 运行指南
对主干的风险 / Risks
独立运行同一条 mkdocs build --strict。基线 23dacd5fb449194c6a8d83e9764534cdbdd081b4 因原相对链接找不到指南而中止,候选成功。git diff --check 通过。主干今后移动该文件时需同步调整链接。本次在本地验证构建与生成页面,公开站点的部署结果留待发布读回。
我的整体评价 / Verdict
APPROVE。 候选满足严格构建与原指南可达这两项要求,文档改动范围与故障一致。
English verdict: APPROVE at d761eb95568007101554f7ab65cc67b669fd1b58. The strict documentation build and the generated runtime-guide link were independently verified. Public deployment remains outside this review.
Goal And Delivered Outcome
The TurnEnvelope protocol links to a runtime guide outside the MkDocs source tree. On main at
23dacd5, strict MkDocs reported that missing document and aborted the Frontstage Pages documentation build.Point the existing anchor to the original guide on GitHub. The intended base is
main. Runtime guideAuthor Declaration
Written by OpenAI Codex (model_agent).
Implemented against
docs/reference/protocols/turn-envelope-v0.mdand.github/workflows/frontstage-pages.ymlat23dacd5Scope And Continuation
The patch changes one link destination in the existing protocol reference. The Pages workflow will validate the combined PR tree.
Validation
Tested revision
d761eb95568007101554f7ab65cc67b669fd1b58. Local checks finished with public repository content.regression_paritypasseddocs/requirements-docs.txt, and an editable LoopX install.manualpassedmain.staticpassedreal_entrypointpassedstaticpassedFrontend / Visual Evidence
UI impact is none. The changed URL is on an existing text link.
Type of Change
LoopX Area